
<!DOCTYPE html>

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta charset="utf-8" />
    <title>lmp.correct_temperature &#8212; Texas A&amp;M Oil spill / Outfall Calculator 2.1.0 documentation</title>
    <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
    <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
    <script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
    <script src="../../_static/jquery.js"></script>
    <script src="../../_static/underscore.js"></script>
    <script src="../../_static/doctools.js"></script>
    <script src="../../_static/language_data.js"></script>
    <link rel="index" title="Index" href="../../genindex.html" />
    <link rel="search" title="Search" href="../../search.html" />
    <link rel="next" title="lmp.correct_particle_tracking" href="lmp.correct_particle_tracking.html" />
    <link rel="prev" title="lmp.calculate" href="lmp.calculate.html" />
   
  <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
  
  
  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

  </head><body>
  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          

          <div class="body" role="main">
            
  <div class="section" id="lmp-correct-temperature">
<h1>lmp.correct_temperature<a class="headerlink" href="#lmp-correct-temperature" title="Permalink to this headline">¶</a></h1>
<dl class="function">
<dt id="lmp.correct_temperature">
<code class="sig-prename descclassname">lmp.</code><code class="sig-name descname">correct_temperature</code><span class="sig-paren">(</span><em class="sig-param">r</em>, <em class="sig-param">particles</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/lmp.html#correct_temperature"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#lmp.correct_temperature" title="Permalink to this definition">¶</a></dt>
<dd><p>Make sure the correct temperature is stored in the state space solution</p>
<p>When the dispersed phase particles equilibrate to their surrounding
temperature, heat transfer is turned off by the methods in 
<cite>dispersed_phases.Particle</cite>.  This is needed to prevent numerical 
oscillation as the particle becomes small.  Unfortunately, it is not as
easy to make the numerical solution compute the correct result once
particle temperature effectively stops being a state space variable since
the state space is intrinsic to the ODE solver.  The derivatives function
computes the correct heat transfer based on the correct state space, but
the state space in the ODE solver remains fixed.</p>
<p>Since the solution for heat in the state space of the ODE solver is the
wrong value, we have to change the external version of the state space
before saving the solution to the current model step.  This follows the
same method and reasoning as the similar function in 
<cite>smp.correct_temperature</cite>.</p>
<p>Hence, the purpose of this function is to overwrite the state space 
solution containing the particle heat that is extrinsic to the ODE solver
and which is used to store the state space following each time step.
The allows the correct temperature to be stored in the model solution.</p>
<dl class="field-list">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl>
<dt><strong>r</strong><span class="classifier"><cite>scipy.integrate.ode</cite> object</span></dt><dd><p>ODE solution containing the current values of the state space in 
the solver’s extrinsic data.  These values are editable, but an 
intrinsic version of these data are used when the solver makes 
calculations; hence, editing this file does not change the state
space stored in the actual solver.</p>
</dd>
<dt><strong>particles</strong><span class="classifier">list of <cite>Particle</cite> objects</span></dt><dd><p>List of <cite>bent_plume_model.Particle</cite> objects containing the dispersed 
phase local conditions and behavior.</p>
</dd>
</dl>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><dl>
<dt><strong>r</strong><span class="classifier"><cite>sciply.integrate.ode</cite> object</span></dt><dd><p>The updated extrinsic state space with the correct values for heat
as were used in the calcualtion.</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>

</div>


          </div>
          
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="../../index.html">Texas A&M Oil spill / Outfall Calculator</a></h1>








<h3>Navigation</h3>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../../user_manual.html">TAMOC User Manual</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../unit_tests.html">Unit Tests</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../bugs.html">Reporting Bugs</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../readme.html">Read Me File</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../release.html">Release Notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../license.html">License</a></li>
</ul>

<div class="relations">
<h3>Related Topics</h3>
<ul>
  <li><a href="../../index.html">Documentation overview</a><ul>
  <li><a href="../../user_manual.html">TAMOC User Manual</a><ul>
  <li><a href="../../modules/bpm.html">Overview of Bent Plume Model Module</a><ul>
      <li>Previous: <a href="lmp.calculate.html" title="previous chapter">lmp.calculate</a></li>
      <li>Next: <a href="lmp.correct_particle_tracking.html" title="next chapter">lmp.correct_particle_tracking</a></li>
  </ul></li>
  </ul></li>
  </ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="../../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" />
      <input type="submit" value="Go" />
    </form>
    </div>
</div>
<script>$('#searchbox').show(0);</script>








        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="footer">
      &copy;2020, Scott A. Socolofsky.
      
      |
      Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.4</a>
      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
      
      |
      <a href="../../_sources/autodoc/bpm/lmp.correct_temperature.rst.txt"
          rel="nofollow">Page source</a>
    </div>

    

    
  </body>
</html>